home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / docshell / nsIDocShellTreeItem.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  11KB  |  258 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIDocShellTreeItem.idl
  3.  */
  4.  
  5. #ifndef __gen_nsIDocShellTreeItem_h__
  6. #define __gen_nsIDocShellTreeItem_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. /* For IDL files that don't want to include root IDL files. */
  14. #ifndef NS_NO_VTABLE
  15. #define NS_NO_VTABLE
  16. #endif
  17. class nsIDocShellTreeOwner; /* forward declaration */
  18.  
  19.  
  20. /* starting interface:    nsIDocShellTreeItem */
  21. #define NS_IDOCSHELLTREEITEM_IID_STR "7d935d63-6d2a-4600-afb5-9a4f7d68b825"
  22.  
  23. #define NS_IDOCSHELLTREEITEM_IID \
  24.   {0x7d935d63, 0x6d2a, 0x4600, \
  25.     { 0xaf, 0xb5, 0x9a, 0x4f, 0x7d, 0x68, 0xb8, 0x25 }}
  26.  
  27. /**
  28.  * The nsIDocShellTreeItem supplies the methods that are required of any item
  29.  * that wishes to be able to live within the docshell tree either as a middle
  30.  * node or a leaf. 
  31.  */
  32. class NS_NO_VTABLE nsIDocShellTreeItem : public nsISupports {
  33.  public: 
  34.  
  35.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IDOCSHELLTREEITEM_IID)
  36.  
  37.   /* attribute wstring name; */
  38.   NS_IMETHOD GetName(PRUnichar * *aName) = 0;
  39.   NS_IMETHOD SetName(const PRUnichar * aName) = 0;
  40.  
  41.   /**
  42.          * Compares the provided name against the item's name and
  43.          * returns the appropriate result.
  44.          *
  45.          * @return <CODE>PR_TRUE</CODE> if names match;
  46.          *         <CODE>PR_FALSE</CODE> otherwise.
  47.          */
  48.   /* boolean nameEquals (in wstring name); */
  49.   NS_IMETHOD NameEquals(const PRUnichar *name, PRBool *_retval) = 0;
  50.  
  51.   enum { typeChrome = 0 };
  52.  
  53.   enum { typeContent = 1 };
  54.  
  55.   enum { typeContentWrapper = 2 };
  56.  
  57.   enum { typeChromeWrapper = 3 };
  58.  
  59.   enum { typeAll = 2147483647 };
  60.  
  61.   /* attribute long itemType; */
  62.   NS_IMETHOD GetItemType(PRInt32 *aItemType) = 0;
  63.   NS_IMETHOD SetItemType(PRInt32 aItemType) = 0;
  64.  
  65.   /* readonly attribute nsIDocShellTreeItem parent; */
  66.   NS_IMETHOD GetParent(nsIDocShellTreeItem * *aParent) = 0;
  67.  
  68.   /* readonly attribute nsIDocShellTreeItem sameTypeParent; */
  69.   NS_IMETHOD GetSameTypeParent(nsIDocShellTreeItem * *aSameTypeParent) = 0;
  70.  
  71.   /* readonly attribute nsIDocShellTreeItem rootTreeItem; */
  72.   NS_IMETHOD GetRootTreeItem(nsIDocShellTreeItem * *aRootTreeItem) = 0;
  73.  
  74.   /* readonly attribute nsIDocShellTreeItem sameTypeRootTreeItem; */
  75.   NS_IMETHOD GetSameTypeRootTreeItem(nsIDocShellTreeItem * *aSameTypeRootTreeItem) = 0;
  76.  
  77.   /* nsIDocShellTreeItem findItemWithName (in wstring name, in nsISupports aRequestor, in nsIDocShellTreeItem aOriginalRequestor); */
  78.   NS_IMETHOD FindItemWithName(const PRUnichar *name, nsISupports *aRequestor, nsIDocShellTreeItem *aOriginalRequestor, nsIDocShellTreeItem **_retval) = 0;
  79.  
  80.   /* readonly attribute nsIDocShellTreeOwner treeOwner; */
  81.   NS_IMETHOD GetTreeOwner(nsIDocShellTreeOwner * *aTreeOwner) = 0;
  82.  
  83.   /* [noscript] void setTreeOwner (in nsIDocShellTreeOwner treeOwner); */
  84.   NS_IMETHOD SetTreeOwner(nsIDocShellTreeOwner *treeOwner) = 0;
  85.  
  86.   /* attribute long childOffset; */
  87.   NS_IMETHOD GetChildOffset(PRInt32 *aChildOffset) = 0;
  88.   NS_IMETHOD SetChildOffset(PRInt32 aChildOffset) = 0;
  89.  
  90. };
  91.  
  92. /* Use this macro when declaring classes that implement this interface. */
  93. #define NS_DECL_NSIDOCSHELLTREEITEM \
  94.   NS_IMETHOD GetName(PRUnichar * *aName); \
  95.   NS_IMETHOD SetName(const PRUnichar * aName); \
  96.   NS_IMETHOD NameEquals(const PRUnichar *name, PRBool *_retval); \
  97.   NS_IMETHOD GetItemType(PRInt32 *aItemType); \
  98.   NS_IMETHOD SetItemType(PRInt32 aItemType); \
  99.   NS_IMETHOD GetParent(nsIDocShellTreeItem * *aParent); \
  100.   NS_IMETHOD GetSameTypeParent(nsIDocShellTreeItem * *aSameTypeParent); \
  101.   NS_IMETHOD GetRootTreeItem(nsIDocShellTreeItem * *aRootTreeItem); \
  102.   NS_IMETHOD GetSameTypeRootTreeItem(nsIDocShellTreeItem * *aSameTypeRootTreeItem); \
  103.   NS_IMETHOD FindItemWithName(const PRUnichar *name, nsISupports *aRequestor, nsIDocShellTreeItem *aOriginalRequestor, nsIDocShellTreeItem **_retval); \
  104.   NS_IMETHOD GetTreeOwner(nsIDocShellTreeOwner * *aTreeOwner); \
  105.   NS_IMETHOD SetTreeOwner(nsIDocShellTreeOwner *treeOwner); \
  106.   NS_IMETHOD GetChildOffset(PRInt32 *aChildOffset); \
  107.   NS_IMETHOD SetChildOffset(PRInt32 aChildOffset); 
  108.  
  109. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  110. #define NS_FORWARD_NSIDOCSHELLTREEITEM(_to) \
  111.   NS_IMETHOD GetName(PRUnichar * *aName) { return _to GetName(aName); } \
  112.   NS_IMETHOD SetName(const PRUnichar * aName) { return _to SetName(aName); } \
  113.   NS_IMETHOD NameEquals(const PRUnichar *name, PRBool *_retval) { return _to NameEquals(name, _retval); } \
  114.   NS_IMETHOD GetItemType(PRInt32 *aItemType) { return _to GetItemType(aItemType); } \
  115.   NS_IMETHOD SetItemType(PRInt32 aItemType) { return _to SetItemType(aItemType); } \
  116.   NS_IMETHOD GetParent(nsIDocShellTreeItem * *aParent) { return _to GetParent(aParent); } \
  117.   NS_IMETHOD GetSameTypeParent(nsIDocShellTreeItem * *aSameTypeParent) { return _to GetSameTypeParent(aSameTypeParent); } \
  118.   NS_IMETHOD GetRootTreeItem(nsIDocShellTreeItem * *aRootTreeItem) { return _to GetRootTreeItem(aRootTreeItem); } \
  119.   NS_IMETHOD GetSameTypeRootTreeItem(nsIDocShellTreeItem * *aSameTypeRootTreeItem) { return _to GetSameTypeRootTreeItem(aSameTypeRootTreeItem); } \
  120.   NS_IMETHOD FindItemWithName(const PRUnichar *name, nsISupports *aRequestor, nsIDocShellTreeItem *aOriginalRequestor, nsIDocShellTreeItem **_retval) { return _to FindItemWithName(name, aRequestor, aOriginalRequestor, _retval); } \
  121.   NS_IMETHOD GetTreeOwner(nsIDocShellTreeOwner * *aTreeOwner) { return _to GetTreeOwner(aTreeOwner); } \
  122.   NS_IMETHOD SetTreeOwner(nsIDocShellTreeOwner *treeOwner) { return _to SetTreeOwner(treeOwner); } \
  123.   NS_IMETHOD GetChildOffset(PRInt32 *aChildOffset) { return _to GetChildOffset(aChildOffset); } \
  124.   NS_IMETHOD SetChildOffset(PRInt32 aChildOffset) { return _to SetChildOffset(aChildOffset); } 
  125.  
  126. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  127. #define NS_FORWARD_SAFE_NSIDOCSHELLTREEITEM(_to) \
  128.   NS_IMETHOD GetName(PRUnichar * *aName) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetName(aName); } \
  129.   NS_IMETHOD SetName(const PRUnichar * aName) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetName(aName); } \
  130.   NS_IMETHOD NameEquals(const PRUnichar *name, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->NameEquals(name, _retval); } \
  131.   NS_IMETHOD GetItemType(PRInt32 *aItemType) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetItemType(aItemType); } \
  132.   NS_IMETHOD SetItemType(PRInt32 aItemType) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetItemType(aItemType); } \
  133.   NS_IMETHOD GetParent(nsIDocShellTreeItem * *aParent) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetParent(aParent); } \
  134.   NS_IMETHOD GetSameTypeParent(nsIDocShellTreeItem * *aSameTypeParent) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSameTypeParent(aSameTypeParent); } \
  135.   NS_IMETHOD GetRootTreeItem(nsIDocShellTreeItem * *aRootTreeItem) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetRootTreeItem(aRootTreeItem); } \
  136.   NS_IMETHOD GetSameTypeRootTreeItem(nsIDocShellTreeItem * *aSameTypeRootTreeItem) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSameTypeRootTreeItem(aSameTypeRootTreeItem); } \
  137.   NS_IMETHOD FindItemWithName(const PRUnichar *name, nsISupports *aRequestor, nsIDocShellTreeItem *aOriginalRequestor, nsIDocShellTreeItem **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->FindItemWithName(name, aRequestor, aOriginalRequestor, _retval); } \
  138.   NS_IMETHOD GetTreeOwner(nsIDocShellTreeOwner * *aTreeOwner) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetTreeOwner(aTreeOwner); } \
  139.   NS_IMETHOD SetTreeOwner(nsIDocShellTreeOwner *treeOwner) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetTreeOwner(treeOwner); } \
  140.   NS_IMETHOD GetChildOffset(PRInt32 *aChildOffset) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetChildOffset(aChildOffset); } \
  141.   NS_IMETHOD SetChildOffset(PRInt32 aChildOffset) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetChildOffset(aChildOffset); } 
  142.  
  143. #if 0
  144. /* Use the code below as a template for the implementation class for this interface. */
  145.  
  146. /* Header file */
  147. class nsDocShellTreeItem : public nsIDocShellTreeItem
  148. {
  149. public:
  150.   NS_DECL_ISUPPORTS
  151.   NS_DECL_NSIDOCSHELLTREEITEM
  152.  
  153.   nsDocShellTreeItem();
  154.  
  155. private:
  156.   ~nsDocShellTreeItem();
  157.  
  158. protected:
  159.   /* additional members */
  160. };
  161.  
  162. /* Implementation file */
  163. NS_IMPL_ISUPPORTS1(nsDocShellTreeItem, nsIDocShellTreeItem)
  164.  
  165. nsDocShellTreeItem::nsDocShellTreeItem()
  166. {
  167.   /* member initializers and constructor code */
  168. }
  169.  
  170. nsDocShellTreeItem::~nsDocShellTreeItem()
  171. {
  172.   /* destructor code */
  173. }
  174.  
  175. /* attribute wstring name; */
  176. NS_IMETHODIMP nsDocShellTreeItem::GetName(PRUnichar * *aName)
  177. {
  178.     return NS_ERROR_NOT_IMPLEMENTED;
  179. }
  180. NS_IMETHODIMP nsDocShellTreeItem::SetName(const PRUnichar * aName)
  181. {
  182.     return NS_ERROR_NOT_IMPLEMENTED;
  183. }
  184.  
  185. /* boolean nameEquals (in wstring name); */
  186. NS_IMETHODIMP nsDocShellTreeItem::NameEquals(const PRUnichar *name, PRBool *_retval)
  187. {
  188.     return NS_ERROR_NOT_IMPLEMENTED;
  189. }
  190.  
  191. /* attribute long itemType; */
  192. NS_IMETHODIMP nsDocShellTreeItem::GetItemType(PRInt32 *aItemType)
  193. {
  194.     return NS_ERROR_NOT_IMPLEMENTED;
  195. }
  196. NS_IMETHODIMP nsDocShellTreeItem::SetItemType(PRInt32 aItemType)
  197. {
  198.     return NS_ERROR_NOT_IMPLEMENTED;
  199. }
  200.  
  201. /* readonly attribute nsIDocShellTreeItem parent; */
  202. NS_IMETHODIMP nsDocShellTreeItem::GetParent(nsIDocShellTreeItem * *aParent)
  203. {
  204.     return NS_ERROR_NOT_IMPLEMENTED;
  205. }
  206.  
  207. /* readonly attribute nsIDocShellTreeItem sameTypeParent; */
  208. NS_IMETHODIMP nsDocShellTreeItem::GetSameTypeParent(nsIDocShellTreeItem * *aSameTypeParent)
  209. {
  210.     return NS_ERROR_NOT_IMPLEMENTED;
  211. }
  212.  
  213. /* readonly attribute nsIDocShellTreeItem rootTreeItem; */
  214. NS_IMETHODIMP nsDocShellTreeItem::GetRootTreeItem(nsIDocShellTreeItem * *aRootTreeItem)
  215. {
  216.     return NS_ERROR_NOT_IMPLEMENTED;
  217. }
  218.  
  219. /* readonly attribute nsIDocShellTreeItem sameTypeRootTreeItem; */
  220. NS_IMETHODIMP nsDocShellTreeItem::GetSameTypeRootTreeItem(nsIDocShellTreeItem * *aSameTypeRootTreeItem)
  221. {
  222.     return NS_ERROR_NOT_IMPLEMENTED;
  223. }
  224.  
  225. /* nsIDocShellTreeItem findItemWithName (in wstring name, in nsISupports aRequestor, in nsIDocShellTreeItem aOriginalRequestor); */
  226. NS_IMETHODIMP nsDocShellTreeItem::FindItemWithName(const PRUnichar *name, nsISupports *aRequestor, nsIDocShellTreeItem *aOriginalRequestor, nsIDocShellTreeItem **_retval)
  227. {
  228.     return NS_ERROR_NOT_IMPLEMENTED;
  229. }
  230.  
  231. /* readonly attribute nsIDocShellTreeOwner treeOwner; */
  232. NS_IMETHODIMP nsDocShellTreeItem::GetTreeOwner(nsIDocShellTreeOwner * *aTreeOwner)
  233. {
  234.     return NS_ERROR_NOT_IMPLEMENTED;
  235. }
  236.  
  237. /* [noscript] void setTreeOwner (in nsIDocShellTreeOwner treeOwner); */
  238. NS_IMETHODIMP nsDocShellTreeItem::SetTreeOwner(nsIDocShellTreeOwner *treeOwner)
  239. {
  240.     return NS_ERROR_NOT_IMPLEMENTED;
  241. }
  242.  
  243. /* attribute long childOffset; */
  244. NS_IMETHODIMP nsDocShellTreeItem::GetChildOffset(PRInt32 *aChildOffset)
  245. {
  246.     return NS_ERROR_NOT_IMPLEMENTED;
  247. }
  248. NS_IMETHODIMP nsDocShellTreeItem::SetChildOffset(PRInt32 aChildOffset)
  249. {
  250.     return NS_ERROR_NOT_IMPLEMENTED;
  251. }
  252.  
  253. /* End of implementation class template. */
  254. #endif
  255.  
  256.  
  257. #endif /* __gen_nsIDocShellTreeItem_h__ */
  258.